<?php
/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_View
 * @subpackage Helper
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: FormLabel.php 19128 2009-11-20 19:19:29Z matthew $
 */

/** Zend_View_Helper_FormElement **/
require_once 'Zend/View/Helper/FormElement.php';

/**
 * Form label helper
 *
 * @category   Zend
 * @package    Zend_View
 * @subpackage Helper
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_View_Helper_FormLabel extends Zend_View_Helper_FormElement
{
	/**
	 * Generates a 'label' element.
	 *
	 * @param  string $name The form element name for which the label is being generated
	 * @param  string $value The label text
	 * @param  array $attribs Form element attributes (used to determine if disabled)
	 * @return string The element XHTML.
	 */
	public function formLabel($name, $value = null, array $attribs = array())
	{
		$info = $this->_getInfo($name, $value, $attribs);
		extract($info); // name, value, attribs, options, listsep, disable, escape

		// build the element
		if ($disable) {
			// disabled; display nothing
			return  '';
		}

		$value = ($escape) ? $this->view->escape($value) : $value;
		$for   = (empty($attribs['disableFor']) || !$attribs['disableFor'])
		? ' for="' . $this->view->escape($id) . '"'
		: '';
		if (array_key_exists('disableFor', $attribs)) {
			unset($attribs['disableFor']);
		}

		// enabled; display label
		$xhtml = '<label'
		. $for
		. $this->_htmlAttribs($attribs)
		. '>' . $value . '</label>';

		return $xhtml;
	}
}
